docs: make contributing guide canonical#10380
Conversation
|
Warning Review limit reached
More reviews will be available in 23 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more credits in the billing tab to continue. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
Comment |
Greptile SummaryReplaces the root
Confidence Score: 5/5Documentation-only change with no code modifications; safe to merge. The change converts a symlink to a plain stub file and edits prose in the contributing guide. There are no code, config, or logic changes of any kind, and the redirect URL matches the project's published docs domain. No files require special attention. Important Files Changed
Reviews (1): Last reviewed commit: "docs: make contributing guide canonical" | Re-trigger Greptile |
Hyperfine Performance
|
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.6.5 x -- echo |
17.8 ± 0.7 | 16.5 | 23.5 | 1.00 |
mise x -- echo |
18.7 ± 1.9 | 16.8 | 51.2 | 1.05 ± 0.11 |
mise env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.6.5 env |
17.7 ± 0.8 | 16.0 | 21.4 | 1.00 |
mise env |
18.5 ± 0.7 | 17.2 | 22.2 | 1.05 ± 0.07 |
mise hook-env
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.6.5 hook-env |
18.4 ± 0.9 | 16.7 | 23.1 | 1.00 |
mise hook-env |
19.1 ± 0.9 | 17.3 | 23.3 | 1.04 ± 0.07 |
mise ls
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|---|---|---|---|---|
mise-2026.6.5 ls |
14.8 ± 0.7 | 13.5 | 17.6 | 1.00 |
mise ls |
15.7 ± 0.8 | 14.2 | 20.6 | 1.06 ± 0.07 |
xtasks/test/perf
| Command | mise-2026.6.5 | mise | Variance |
|---|---|---|---|
| install (cached) | 131ms | 133ms | -1% |
| ls (cached) | 58ms | 59ms | -1% |
| bin-paths (cached) | 61ms | 61ms | +0% |
| task-ls (cached) | 121ms | 124ms | -2% |
1 participant
Summary
docs/contributing.mdfor VitePressCONTRIBUTING.mdwith a short link to the published docs pageWhy
GitHub prefers the repository-root
CONTRIBUTING.md, but VitePress can fail when a docs page is a symlink that resolves outsidedocs/. Keeping the full guide in docs and using a small root pointer avoids both problems.Validation
mise run docs:buildNote
Low Risk
Documentation and contributor-facing text only; no runtime, auth, or build logic changes beyond how contributing content is hosted.
Overview
Docs-only split so GitHub still has a root
CONTRIBUTING.mdwhile VitePress keeps the full page underdocs/(avoids symlink-outside-docs/build issues).Root
CONTRIBUTING.mdis now a brief pointer to the published contributing guide. The complete guide stays indocs/contributing.md.Copy edits in the docs page: merged the old duplicate “before you PR” intro into Contribution Expectations; review gates now explicitly call out Conventional Commits on PR titles; the old “Contributing Guidelines” / “Pull Request Workflow” blocks become a single Pull Request Checklist with
mise run render/mise run lint-fixand renumbered development tips.Reviewed by Cursor Bugbot for commit 390affb. Bugbot is set up for automated code reviews on this repo. Configure here.